home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d22 / cedar100.arc / CEDAR.DOC < prev    next >
Text File  |  1989-07-24  |  23KB  |  559 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.                        C E D A R    1 . 0 0  /  2 . 0 0
  17.  
  18.                                  Users Guide
  19.  
  20.                      Copywrite (c) 1989 by Fred Van Andel
  21.                              All rights reserved.
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.                                  Fred Van Andel
  34.                                 414 Richmond st.
  35.                               New Westminster B.C.
  36.                                     Canada
  37.                                     V3L 4C2
  38.  
  39.  
  40.  
  41.  
  42. 1.0 What is CEDAR.
  43.    CEDAR is a directory program with a difference.  The most important
  44.    advantage that CEDAR has over other directory programs is that it will
  45.    allow you to list your files in color.  You can choose what color you want
  46.    each type of file displayed in based on the file extension (assuming you
  47.    have a color monitor).  As well CEDAR will list your files in 1, 2, 4 or 6
  48.    columns, and it will sort your files by almost anything.
  49.  
  50.    For example, you can have all .COM, .EXE, and .BAT files shown in red,
  51.    while all .DOC and .TXT files are green, all your subdirectories are in
  52.    magenta, and all other files are white.  You can set up to 200 different
  53.    file extension/color pairs (20 in the Shareware version) at a time and
  54.    change them easily.  In addition CEDAR is configurable, you can set the
  55.    sort and display parameters at the same time as the colors.  Whenever you
  56.    run CEDAR it will always list the files the way you want it to.
  57.  
  58. 2.0 Registration.
  59.    There are two versions of CEDAR.  The Shareware version and the registered
  60.    version.  The Shareware version has a version number of 1.XX, the
  61.    registered version has a version number of 2.XX.
  62.  
  63.    The Shareware version (1.XX) of these programs and documentation are
  64.    copywrite and have been released to the public as Shareware.
  65.  
  66.       THESE ARE NOT PUBLIC DOMAIN OR FREE PROGRAMS.
  67.  
  68.    Anyone may use this program on a trial basis for 30 days without
  69.    obligation.  If you find this program useful and continue to use it you are
  70.    expected to register your copy.  All government, commercial and business
  71.    users of this program are required to register their copy.
  72.  
  73. 2.1 Why Register?
  74.       If you register you will get:
  75.         A disk containing the latest registered version of CEDAR (Version 2.00
  76.         or above).
  77.  
  78.         The registered version of these programs and documentation are similar
  79.         except they have more options (see section 3.2.X on command line
  80.         switches for more details).  As well the registered version can set
  81.         200 color combinations instead of 20.  The Shareware version of CEDAR
  82.         is NOT Crippleware.  It is both functional and useful.  I just want
  83.         to give people a reason to register their copy.
  84.  
  85.         All registered users will receive notification of major revisions and
  86.         will be able to upgrade at nominal cost.
  87.  
  88.         A sense of pride and ownership, in having honestly participated in the
  89.         Shareware revolution.
  90.  
  91.         You help to keep software prices down, by supporting a distribution
  92.         method which doesn't rely on expensive advertising campaigns.
  93.  
  94.    To register please fill out the registration form at the end of this file
  95.    or run CEDAR with the /f option and send it and the registration fee to
  96.    Fred Van Andel.
  97.  
  98.    The survival of the Shareware method of distribution depends on people
  99.    registering their programs.
  100.  
  101.    The Shareware version (1.XX) of these programs and documentation files may
  102.    be freely copied and distributed by any individual, or nonprofit
  103.    organization, under the following conditions.
  104.  
  105.       CEDAR and any associated files may NOT be distributed as part of any
  106.       other Shareware, public domain or commercial package except with prior
  107.       written approval from Fred Van Andel.
  108.  
  109.       Shareware distributors and user groups may distribute this package as
  110.       part of a disk library if the fee charged is less than $5.00 per disk.
  111.       Please write and inform me if you do so.
  112.  
  113.       All program and documentation files must be distributed together and may
  114.       not be modified in any way.
  115.  
  116.       Commercial use of the Shareware (1.XX) version is prohibited, you must
  117.       register your copy in order to use it for business.
  118.  
  119.    The Registered version (2.XX) of CEDAR and all associated files may not be
  120.    distributed in any form except by Fred Van Andel or its designated agents.
  121.  
  122.    The Registered version (2.XX) of CEDAR must be treated like a book, you can
  123.    make backup copies as long as the same registered copy of CEDAR cannot be
  124.    used by more than one computer at the same time.
  125.  
  126. DISCLAIMER
  127.  
  128.    THIS SOFTWARE AND MANUAL IS SOLD "AS IS" AND WITHOUT WARRANTIES AS TO
  129.    PERFORMANCE OR SUITABILITY OR ANY OTHER WARRANTIES WHETHER EXPRESS OR
  130.    IMPLIED.  IN NO EVENT SHALL FRED VAN ANDEL BE HELD LIABLE FOR ANY LOSS OF
  131.    PROFIT OR ANY DAMAGES RESULTING FROM THE USE OR MISUSE OF THIS PRODUCT,
  132.    EVEN IF FRED VAN ANDEL HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  133.    THE USE OF THIS PROGRAM(S) CONSTITUTES AGREEMENT AND ACCEPTANCE OF THESE
  134.    CONDITIONS.
  135. 3.0 Running CEDAR.
  136.     In its simplest form CEDAR is run from the DOS prompt by typing its name
  137.     followed by a return.  If you have not changed any of the defaults:
  138.  
  139.         CEDAR
  140.  
  141.     will give you a listing similar to this one.
  142.  
  143. CEDAR 2.00 Registered Version  Copyright (c) 1989 by F Van Andel  /? for Help
  144. Path: C:\MISC Filespec: *.*
  145. ───────────────────┬───────────────────┬───────────────────┬───────────────────
  146. .       <DIR>      │BIG     .TXT   1.2M│COMMAND .COM  25308│README  .DOC 1024
  147. ..      <DIR>      │CEDAR   .C    23664│FIND    .EXE   6403│XCOPY   .EXE 11216
  148. JUNK    <DIR>      │CEDAR   .CTL   3320│FORMAT  .COM  11671│
  149. ANSI    .SYS   1647│CEDAR   .DOC  19545│LABEL   .COM   2346│
  150. BEEP    .COM      7│CEDAR   .H      243│MISC    .DOC 169378│
  151. ───────────────────┴───────────────────┴───────────────────┴───────────────────
  152.   17 Files using  1.5M  Bytes.   475136 Bytes free.
  153.  
  154.     This is a 4 column listing of all files in the directory showing filename,
  155.     extension and size sorted by type, name and extension.  At the bottom it
  156.     will show how many files are listed, the total size of the listed files
  157.     and how much free disk space is available.  What you can't see is the
  158.     color, you will just have to run it yourself for that.
  159.  
  160.     Please note that if the file sizes or the totals exceeds 1 million bytes
  161.     then the size will be displayed in megabytes.  For example: 1.5M  Bytes.
  162.  
  163. 3.1 Filespec.
  164.     If all you want to see is the .EXE and the .COM files then you use the
  165.     command:
  166.  
  167.        CEDAR *.exe *.com
  168.  
  169.     Unlike the DIR command in DOS you can give more than one filespec on the
  170.     command line.  You can even run CEDAR across directories and drives.  For
  171.     example:
  172.  
  173.        CEDAR *.* a:*.doc b:*.doc
  174.  
  175.     will give you a list of all the files on your current directory and all
  176.     the .DOC files on your a: and b: drives.  Note however the amount of free
  177.     disk space reported will be that of your b: drive.  You can have up to 9
  178.     different pathnames.
  179.  
  180.     Please note that the directories . and .. will be listed more than once if
  181.     your filespec allows it.  The . and .. directories can be suppressed, see
  182.     section 3.2.3.
  183. 3.2 Switches.
  184.     Command line switches are supported by using the backslash character (/).
  185.     For example, to use a 2 column format and sort by file size you would use
  186.     the command:
  187.  
  188.         CEDAR /2 /s
  189.      or
  190.         CEDAR /2s
  191.  
  192.     Using command line switches it is possible to control how CEDAR runs.
  193.     There are 4 basic groups of switches, those that control sorting, those
  194.     that control how the files are displayed, those that control how the files
  195.     are output, and those that control other things.
  196.  
  197.     Some switches allow the use of a minus sign (-) after them to allow for
  198.     the canceling of a switch or to reverse the order.  See the descriptions
  199.     for /n, /e, /s, /t, /d.  /y, /o, /c, /u, /p, and /i for more information.
  200.  
  201. 3.2.1 Display Switches.
  202.     The directory can be listed in either 1, 2, 4 or 6 columns.  The switches
  203.     are:
  204.  
  205.     /1  1 column.  Displays the directory in a single column similar to DOS
  206.         DIR.  The files name, extension, size, time and date are shown.
  207.  
  208.     /2  2 column.  Displays the directory in 2 columns.  The same information
  209.         as /1 is shown except it is 2 columns side by side.
  210.  
  211.     /4  4 column.  Displays filename, extension and size  in 4 columns.
  212.  
  213.     /6  6 column.  Displays filename and extension only in 6 columns, similar
  214.         to DOS DIR /w command.
  215.  
  216.     /h  Horizontal.  Displays the files across instead of down.  This option
  217.         is not available in the Shareware version.  Please register your copy.
  218.  
  219.     /v  Vertical.  Displays the files down instead of across.  This option is
  220.         not available in the Shareware version.  Please register your copy.
  221.  
  222. 3.2.2 Sort Switches.
  223.     The directory can be sorted almost any order you want.
  224.  
  225.     In general by following a switch by a minus sign then the sorting will be
  226.     in reverse order.  For example:
  227.  
  228.         CEDAR \s-
  229.  
  230.     will sort the files from smallest to largest instead of largest to
  231.     smallest.
  232.  
  233.     /n  sort by file Name.  Files are sorted in ASCII order, punctuation
  234.         before numbers before letters.  /n- sorts in the reverse order.
  235.  
  236.     /e  sort by file Extension.  Extensions are sorted in ASCII order,
  237.         punctuation before numbers before letters.  /e- sorts in the reverse
  238.         order.
  239.  
  240.     /s  sort by Size.  Larger files are listed before smaller files.
  241.         Directories (which have zero size) are last.  /s- sorts from smallest
  242.         to largest.  This option is not available in the Shareware version.
  243.         Please register your copy to get this feature.
  244.  
  245.     /t  sort by Time.  Older files are listed first.  /t- sorts from newest to
  246.         oldest.  This option is not available in the Shareware version.
  247.         Please register your copy to get this feature.
  248.  
  249.     /d  sort by Date.  Older files are listed first.  /s- sorts from newest to
  250.         oldest.  This option is not available in the Shareware version.
  251.         Please register your copy to get this feature.
  252.  
  253.     /y  sort by tYpe.  Directories will be listed before regular files.  /y-
  254.         will list directories last.
  255.  
  256.     /o  sorted by Order.  Files will be sorted according to the order that
  257.         they appear in the CEDAR.CTL file.  See section 4.0 on Configuration
  258.         for more details.  /o- will sort files in the opposite order.  This
  259.         option is not available in the Shareware version.  Please register
  260.         your copy to get this feature.
  261.  
  262.     /c  sort by Color.  Files will be sorted according to there color number.
  263.         See section 4.0 on configuration for more information on colors.  /c-
  264.         will sort in the opposite order.  This option is not available in the
  265.         Shareware version.  Please register your copy to get this feature.
  266.  
  267.     /u  Unsorted, do not sort the files but display them as they are on the
  268.         disk.  If this option is used any other sort option on the command
  269.         line such as /n or /t will be ignored.  /u- will cancel the /u
  270.         command.  This is for when there is a /u set by the configuration file
  271.         and you want to cancel it.  Using /u- will allow other sort switches
  272.         such as /n and /t to be processed.
  273.  
  274.     Note: It is possible to sort on an item that is not displayed, for
  275.           example:
  276.  
  277.             CEDAR \t4  *.exe
  278.  
  279.           will sort by time, but the file time is not displayed in the 4
  280.           column format.
  281. 3.2.3 Control Switches.
  282.     These switches control various aspects of how CEDAR works.
  283.  
  284.    /?   Help.  A short summary of all the switches.
  285.  
  286.    /r or
  287.    /r [filename]
  288.         Reset.  This will reset or configure CEDAR to use new colors and set
  289.         new defaults.  If [filename] not is given then the file CEDAR.CTL will
  290.         be used.  See section 4.0 on configuration for more details.
  291.  
  292.     /p  Pause.  This will display a screen full (24 lines) and ask you to hit
  293.         a key before continuing.  /p- will turn pausing off, this is for when
  294.         there is a /p set by the configuration file and you want to cancel it.
  295.  
  296.     /f  Form.  This will display a registration form after to the screen,
  297.         printer or a file called REGISTER.FRM after prompting you for your
  298.         choice.
  299.  
  300.     /i  Ignore.  This will suppress the listing of the . and .. directories.
  301.         /i- will display the . and .. directories, for when there is a /i set
  302.         by the configuration file and you want to cancel it.  This option is
  303.         not available in the Shareware version.  Please register your copy to
  304.         get this feature.
  305.  
  306. 3.2.4 Output Switches
  307.     Output switches control how the listing is displayed.
  308.  
  309.     /b  Bios.  This causes CEDAR to use the BIOS to write to the screen.  This
  310.         method allows colors to be displayed but does not support redirection.
  311.  
  312.         This is the default mode.  If no output switches are specified in the
  313.         configuration file or on the command line this is the mode that will
  314.         be used.  This switch is not available in the Shareware version.
  315.         Please register your copy to get this feature.
  316.  
  317.     /x  DOS.  This mode uses DOS to write to the screen.  It does not allow
  318.         color but it does allow redirection.  For example:
  319.  
  320.             CEDAR /x2 *.doc *.txt > test.dir
  321.  
  322.         will write the directory to the file test.dir.
  323.  
  324.             CEDAR /x >prn
  325.  
  326.         will send the directory to the printer.
  327.  
  328.         Please note that if you use the pause (/p) option while redirecting
  329.         the output the prompt to hit a key will also be redirected and will
  330.         not appear on the screen.  I am sorry that /x doesn't sound like
  331.         anything but I ran out of appropriate letters.  This option is not
  332.         available in the Shareware version.  Please register your copy to get
  333.         this feature.
  334.  
  335.     /a  Ansi.  This mode uses the ANSI.SYS driver to display the directory.
  336.         This mode is redirectable and it also allows color.  However it is
  337.         slow.  If you redirect this mode to the printer or a file you will get
  338.         a lot of extra characters between the columns.  You can redirect this
  339.         mode over a modem and receive color on the other side, or you can
  340.         redirect to a file and when you TYPE that file you will see color.
  341.  
  342.         The ANSI.SYS driver must be loaded for this to work.  Ie.  You must
  343.         have a line in your CONFIG.SYS file that says:
  344.  
  345.            device=[path]ansi.sys
  346.  
  347.         If the ANSI.SYS driver is not present then you will get a lot of extra
  348.         characters between the columns and no color.
  349.  
  350. 4.0  Configuration
  351.     Configuration is the most important and powerful feature of CEDAR.  It
  352.     allows you to set up the file extension and color combinations the way you
  353.     want them as well as set up the default switches.
  354.  
  355.     When you use the Reset default switch (/r) CEDAR will read from the
  356.     configuration file and modify itself based on what the file contains.  The
  357.     command is as follows:
  358.  
  359.        CEDAR /r c:\utilities\default.cfg
  360.  
  361.     If no filename is given then CEDAR will use the file CEDAR.CFG.  If CEDAR
  362.     cannot find this file the program will abort.
  363.  
  364.     The format for the configuration file is simple.
  365.  
  366.     To set the file extension/color combinations you list the file extension
  367.     including the period, followed by the number for the color.  For Example:
  368.  
  369.        .exe 12  ; light red on black
  370.        .com 12
  371.        .bat 12
  372.        .doc 13  ; light magenta on black
  373.        .txt 13
  374.  
  375.     This will set up cedar so that .exe, .com, and .bat files are displayed in
  376.     color 12 (Light red letters on a black background) and all .doc and .txt
  377.     files are displayed in color 13 (Light Magenta on Black).  In the
  378.     registered version you can set to 200 file extension, color combinations.
  379.     In the Shareware release you can set up to 20.
  380.  
  381.     Everything after a semicolon (;) on a line is a comment and will be
  382.     ignored.
  383.  
  384.     The number representing the color is the standard color attributes for a
  385.     CGA display.  If you have a different type of display the colors might be
  386.     different depending on how it has been set up.
  387.  
  388.     The standard colors are:
  389.  
  390.     COLOR       FOREGROUND     BACKGROUND
  391.     -----       ----------     ----------
  392.     Black           0                0
  393.     Blue            1               16
  394.     Green           2               32
  395.     Cyan            3               48
  396.     Red             4               64
  397.     Magenta         5               80
  398.     Brown           6               96
  399.     White           7              112
  400.     Grey            8
  401.     Light Blue      9
  402.     Light Green    10
  403.     Light Cyan     11
  404.     Light Red      12
  405.     Light Magenta  13
  406.     Yellow         14
  407.     Bright White   15
  408.  
  409.     To Get the desired foreground, background colors add the two numbers
  410.     together.  For example the number for white letters on a blue background
  411.     is 7 (White) + 16 (Blue) = 23 (White on Blue).  If you then add 128 to
  412.     this number the colors will flash on and off.
  413.  
  414.     In the ansi mode (/a) not all colors are possible.  Only the first 8
  415.     foreground colors are allowed.  Any color after white will be displayed as
  416.     that color number minus 8.
  417.  
  418.     On a monochrome monitor color is rather meaningless.  Instead of
  419.     displaying color you might get underlining.  Use the DOS switch (/x)
  420.     instead of the BIOS switch (/b) or edit the CEDAR.CTL to change the colors
  421.     to something more appropriate.
  422.  
  423.     If you run the program SEECOLOR.EXE it will display a table of all the
  424.     color combinations and you can clearly see what they look like.
  425.  
  426.     There are some special file extension rules.  Directories are specified by
  427.     <dir>.  The default color is specified by #def.  This color is used for
  428.     files that don't match any specified extension as well as the titles,
  429.     borders, and footers.  For Example:
  430.  
  431.        <dir>  27 ; Will display directories in color 27.
  432.        #def   33 ; Will display the title borders, footers and
  433.                  ; unknown file types in color 33.
  434.  
  435.     The command #swi allows you to set the default command line switches.
  436.     These switches will be used if no switches are specified when running the
  437.     program.For example:
  438.  
  439.     If your CEDAR.CTL file contained the line
  440.  
  441.         #swi /2p
  442.  
  443.     Then every time you ran CEDAR without any command line switches then CEDAR
  444.     will run as if you had typed
  445.  
  446.         CEDAR /2p
  447.  
  448.     When using the #swi command you must have all your options as part of one
  449.     switch.  For Example you must always use
  450.  
  451.         #swi /ys-
  452.  
  453.     instead of
  454.  
  455.         #swi /y /s-
  456.  
  457.     If you use the second method you will get an invalid option error.  This
  458.     applies for the configuration file only, you still can split up your
  459.     switches on the command line without any problems.
  460.  
  461.     If no Sort switches are set by either the command line or the
  462.     configuration file then /yne will be used.
  463.  
  464.     If no Display switches are set by either the command line or the
  465.     configuration file then /4v will be used.
  466.  
  467.     If no Output switches are set by either the command line or the
  468.     configuration file then /b will be used.
  469.  
  470. 5.0 Version History
  471.  
  472.        April 26, 1989   Version 0.90
  473.                         Beta test version.  Very limited release.
  474.  
  475.        June xx, 1989    Version 1.00
  476.                         Initial release.
  477.  
  478.  
  479.        Possible future enhancements
  480.  
  481.          Allow wildcards, so configuration file entries such as .wk? 12 will
  482.          work.
  483.  
  484.          Color displayed based of entire file name instead of just the
  485.          extension.
  486.  
  487.             For Example, an entry in the configuration of:
  488.  
  489.                tax*.wks 15
  490.  
  491.             would work.
  492.  
  493.          Make CEDAR aware of different types of video monitors (EGA and VGA)
  494.          so that it is not tied into an 80 column by 25 line screen.
  495.  
  496.          Make the executable program smaller.
  497.  
  498.  
  499.  
  500. 6.0 Registration Form
  501.                       CEDAR 2.00  ORDER FORM
  502.  
  503. Please send with check or money order to:
  504.  
  505. Fred Van Andel                          Date:_____________________
  506. 414 Richmond St.
  507. New Westminster B.C.
  508. Canada V3L 4C2
  509.  
  510. From:
  511. Name: ________________________________________________
  512. Address:______________________________________________
  513. City:_________________________________________________
  514. Province/State:_______________________________________
  515. Postal/Zip:___________________________________________
  516. Phone:(_____)_________________________________________
  517.  
  518.  
  519. Enclosed is a check or Money Order for the following:
  520.                                                 US  / CDN
  521. Registration of CEDAR 2.00    _____  copies @ $15.00/$17.00 ea $_______.
  522.   (Includes Registration, program
  523.    and manual on disk)
  524.                                          -Discount:            $(______)
  525.                    B.C.Residents add 6% sales tax:            $_______.
  526.                                              Total:            $_______.
  527.  
  528. Multiple copies of CEDAR are subject to the following discount:
  529.  
  530.              1  to   9 copies     no discount.
  531.             10  to  24 copies    10% discount.
  532.             25  to  99 copies    20% discount.
  533.             100+       copies    30% discount.
  534.  
  535.  
  536. Please rate this package on a scale of 1 to 10:
  537.  
  538.             Usefulness:   _____
  539.             Power:         _____
  540.             Ease of use:   _____
  541.             Documentation: _____
  542.             Value:         _____
  543.  
  544. General Comments:_______________________________________________________
  545. ________________________________________________________________________
  546. ________________________________________________________________________
  547. ________________________________________________________________________
  548. ________________________________________________________________________
  549.  
  550. What features would you like to see in the future:_____________________
  551. ________________________________________________________________________
  552. ________________________________________________________________________
  553. ________________________________________________________________________
  554. ________________________________________________________________________
  555.  
  556.  
  557. Signature:_______________________________________
  558.  
  559.